GET Outstream Player by PublicId

Overview

---

The following table contains important information about the GET method in regards to receiving the outstream player by using the public ID.

GET Outstream Player by PublicId
Method	GET
URL or Endpoint	/api/v1/projects/projectId/outstream-players/id
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique id of the outstream player.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [],
  "result": {
    "publicId": "string",
    "name": "string",
    "responsive": true,
    "width": 0,
    "height": 0,
    "releaseChannelId": 0,
    "muteOnStart": true,
    "viewableThresholdPercentage": 0,
    "autoStartOnViewableOn": true,
    "autoPauseOnViewableOn": true,
    "volumeSlider": true,
    "playButton": true,
    "muteButton": true,
    "controlBarIconsDefaultColor": "string",
    "controlBarIconsHoverColor": "string",
    "controlBarSliderProgressColor": "string",
    "controlBarSliderRailColor": "string",
    "controlBarSliderDraggerColor": "string",
    "orderNumber": 0,
    "releaseChannel": {
      "id": 0,
      "name": "string",
      "originalPath": "string",
      "templateOriginalPath": "string"
    }
  },
  "resultInfo": "string",
  "statusCode": 0
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful, it returns true; otherwise, it returns false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	array[Object]	Returns the response object.
publicId	string	The public ID of the player.
name	string	The name of the player.
responsive	boolean	Indicates whether the player is responsive.
width	integer	The width of the player.
height	integer	The height of the player.
releaseChannelId	integer	The ID of the release channel.
muteOnStart	boolean	Indicates whether the player is muted on start.
viewableThresholdPercentage	number	The percentage of the player that must be viewable for certain actions (e.g., auto-start) to occur.
autoStartOnViewableOn	boolean	Indicates whether auto-start is enabled when the player becomes viewable.
autoPauseOnViewableOn	boolean	Indicates whether auto-pause is enabled when the player becomes unviewable.
volumeSlider	boolean	Indicates whether the volume slider is enabled.
playButton	boolean	Indicates whether the play button is enabled.
muteButton	boolean	Indicates whether the mute/unmute button is enabled.
controlBarIconsDefaultColor	string	Color for control bar icons in default state.
controlBarIconsHoverColor	string	Color for control bar icons on hover.
controlBarSliderProgressColor	string	Color of the progress part of the control bar slider.
controlBarSliderRailColor	string	Color of the rail (background) of the control bar slider.
controlBarSliderDraggerColor	string	Color of the dragger (handle) on the control bar slider.
orderNumber	integer	The order number of the player.
releaseChannel	Object	Returns details about the release channel.
releaseChannel.id	integer	The ID of the release channel.
releaseChannel.name	string	The name of the release channel.
releaseChannel.originalPath	string	The original file path of the release channel.
releaseChannel.templateOriginalPath	string	The original template file path of the release channel.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed